mdast-util-find-and-replace
Advanced tools
The mdast-util-find-and-replace npm package is a utility for finding and replacing text or patterns in Markdown Abstract Syntax Trees (MDAST). It is particularly useful for manipulating Markdown documents programmatically, allowing developers to automate content updates, apply transformations, and enhance Markdown processing workflows.
Text Replacement
This feature allows you to replace specific text in the MDAST. In the provided code, 'world' is replaced with 'universe' within the text node of a paragraph.
const u = require('unist-builder');
const findAndReplace = require('mdast-util-find-and-replace');
const tree = u('paragraph', [
u('text', 'Hello world!')
]);
findAndReplace(tree, {'world': 'universe'});
console.log(tree);Pattern Replacement with Callback
This feature allows replacing patterns using regular expressions. In the example, occurrences of 'example.com' are turned into clickable links.
const u = require('unist-builder');
const findAndReplace = require('mdast-util-find-and-replace');
const tree = u('paragraph', [
u('text', 'Visit example.com for more info.')
]);
findAndReplace(tree, /example\.com/g, (match) => {
return {
type: 'link',
url: 'http://example.com',
children: [{type: 'text', value: match}]
};
});
console.log(tree);remark-retext is a plugin that bridges between remark (Markdown processor) and retext (natural language processor). While it focuses on natural language processing, it can be used in conjunction with plugins like retext-string-replace to achieve similar find-and-replace functionalities. However, it requires setting up a pipeline with retext, making it less direct than mdast-util-find-and-replace for simple replacements.
unist-util-visit is a utility for traversing Unist nodes, which can be used to manually implement find-and-replace functionalities by visiting nodes and modifying them. It offers more control and customization over how nodes are visited and modified compared to mdast-util-find-and-replace, which is more specialized and straightforward for text replacements.
mdast utility to find and replace things.
This package is a utility that lets you find patterns (string, RegExp) in
text and replace them with nodes.
This utility is typically useful when you have regexes and want to modify mdast.
One example is when you have some form of “mentions” (such as
/@([a-z][_a-z0-9])\b/gi) and want to create links to persons from them.
A similar package, hast-util-find-and-replace
does the same but on hast.
This package is ESM only. In Node.js (version 14.14+ and or 16.0+), install with npm:
npm install mdast-util-find-and-replace
In Deno with esm.sh:
import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@2'
In browsers with esm.sh:
<script type="module">
import {findAndReplace} from 'https://esm.sh/mdast-util-find-and-replace@2?bundle'
</script>
import {u} from 'unist-builder'
import {inspect} from 'unist-util-inspect'
import {findAndReplace} from 'mdast-util-find-and-replace'
const tree = u('paragraph', [
u('text', 'Some '),
u('emphasis', [u('text', 'emphasis')]),
u('text', ' and '),
u('strong', [u('text', 'importance')]),
u('text', '.')
])
findAndReplace(tree, [
[/and/gi, 'or'],
[/emphasis/gi, 'em'],
[/importance/gi, 'strong'],
[
/Some/g,
function ($0) {
return u('link', {url: '//example.com#' + $0}, [u('text', $0)])
}
]
])
console.log(inspect(tree))
Yields:
paragraph[8]
├─0 link[1]
│ │ url: "//example.com#Some"
│ └─0 text "Some"
├─1 text " "
├─2 emphasis[1]
│ └─0 text "em"
├─3 text " "
├─4 text "or"
├─5 text " "
├─6 strong[1]
│ └─0 text "strong"
└─7 text "."
This package exports the identifier findAndReplace.
There is no default export.
findAndReplace(tree, find, replace[, options])Find patterns in a tree and replace them.
The algorithm searches the tree in preorder for complete values in
Text nodes.
Partial matches are not supported.
findAndReplace(tree, find, replace[, options])findAndReplace(tree, search[, options])tree (Node)
— tree to changefind (Find)
— value to find and removereplace (Replace)
— thing to replace withsearch (FindAndReplaceSchema or
FindAndReplaceList)
— several find and replacesoptions (Options)
— configurationGiven, modified, tree (Node).
FindPattern to find (TypeScript type).
Strings are escaped and then turned into global expressions.
type Find = string | RegExp
FindAndReplaceListSeveral find and replaces, in array form (TypeScript type).
type FindAndReplaceList = Array<FindAndReplaceTuple>
See FindAndReplaceTuple.
FindAndReplaceSchemaSeveral find and replaces, in object form (TypeScript type).
type FindAndReplaceSchema = Record<string, Replace>
See Replace.
FindAndReplaceTupleFind and replace in tuple form (TypeScript type).
type FindAndReplaceTuple = [Find, Replace]
OptionsConfiguration (TypeScript type).
ignore (Test, optional)
— test for which elements to ignoreRegExpMatchObjectInfo on the match (TypeScript type).
index (number)
— the index of the search at which the result was foundinput (string)
— a copy of the search string in the text nodestack (Array<Node>)
— all ancestors of the text node, where the last node is the text itselfReplaceThing to replace with (TypeScript type).
type Replace = string | ReplaceFunction
See ReplaceFunction.
ReplaceFunctionCallback called when a search matches (TypeScript type).
The parameters are the result of corresponding search expression:
value (string)
— whole match...capture (Array<string>)
— matches from regex capture groupsmatch (RegExpMatchObject)
— info on the matchThing to replace with:
null, undefined, '', remove the matchfalse, do not replace at allstring, replace with a text node of that valueNode or Array<Node>, replace with those nodesThis package is fully typed with TypeScript.
It exports the additional types Find,
FindAndReplaceList,
FindAndReplaceSchema,
FindAndReplaceTuple,
Options,
RegExpMatchObject,
Replace, and
ReplaceFunction.
Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.
Use of mdast-util-find-and-replace does not involve hast or user content
so there are no openings for cross-site scripting (XSS) attacks.
hast-util-find-and-replace
— find and replace in hasthast-util-select
— querySelector, querySelectorAll, and matchesunist-util-select
— select unist nodes with CSS-like selectorsSee contributing.md in syntax-tree/.github for
ways to get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.
FAQs
mdast utility to find and replace text in a tree
We found that mdast-util-find-and-replace demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.
Security News
RubyGems.org has added a new "maintainer" role that allows for publishing new versions of gems. This new permission type is aimed at improving security for gem owners and the service overall.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.